<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Database xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/apache/torque/Database.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../org/apache/torque/package-summary.html">org.apache.torque</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> org.apache.torque.adapter.DB;
<a name="23" href="#23">23</a>  <strong>import</strong> org.apache.torque.dsfactory.DataSourceFactory;
<a name="24" href="#24">24</a>  <strong>import</strong> org.apache.torque.map.DatabaseMap;
<a name="25" href="#25">25</a>  <strong>import</strong> org.apache.torque.oid.IDBroker;
<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.torque.oid.IdGenerator;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <em>/**<em>*</em></em>
<a name="29" href="#29">29</a>  <em> * Bundles all information about a database. This includes the database adapter,</em>
<a name="30" href="#30">30</a>  <em> * the database Map and the Data Source Factory.</em>
<a name="31" href="#31">31</a>  <em> */</em>
<a name="32" href="#32">32</a>  <strong>public</strong> <strong>class</strong> <a href="../../../org/apache/torque/Database.html">Database</a>
<a name="33" href="#33">33</a>  {
<a name="34" href="#34">34</a>      <em>/**<em>*</em></em>
<a name="35" href="#35">35</a>  <em>     * The name of the database. Must be the same as the key in Torque's</em>
<a name="36" href="#36">36</a>  <em>     * databaseMap.</em>
<a name="37" href="#37">37</a>  <em>     */</em>
<a name="38" href="#38">38</a>      <strong>private</strong> String name;
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>      <em>/**<em>*</em></em>
<a name="41" href="#41">41</a>  <em>     * The Database adapter which encapsulates database-specific peculiarities.</em>
<a name="42" href="#42">42</a>  <em>     */</em>
<a name="43" href="#43">43</a>      <strong>private</strong> <a href="../../../org/apache/torque/adapter/DB.html">DB</a> adapter;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>      <em>/**<em>*</em></em>
<a name="46" href="#46">46</a>  <em>     * the Map of this database.</em>
<a name="47" href="#47">47</a>  <em>     */</em>
<a name="48" href="#48">48</a>      <strong>private</strong> <a href="../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a> databaseMap;
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>      <em>/**<em>*</em></em>
<a name="51" href="#51">51</a>  <em>     * The DataSourceFactory to optain connections to this database.</em>
<a name="52" href="#52">52</a>  <em>     */</em>
<a name="53" href="#53">53</a>      <strong>private</strong> <a href="../../../org/apache/torque/dsfactory/DataSourceFactory.html">DataSourceFactory</a> dataSourceFactory;
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em>/**<em>*</em></em>
<a name="56" href="#56">56</a>  <em>     * Creates a new Database with the given name.</em>
<a name="57" href="#57">57</a>  <em>     *</em>
<a name="58" href="#58">58</a>  <em>     * @param aName the name of the database, not null.</em>
<a name="59" href="#59">59</a>  <em>     */</em>
<a name="60" href="#60">60</a>      <a href="../../../org/apache/torque/Database.html">Database</a>(String aName)
<a name="61" href="#61">61</a>      {
<a name="62" href="#62">62</a>          <strong>this</strong>.name = aName;
<a name="63" href="#63">63</a>      }
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>      <em>/**<em>*</em></em>
<a name="66" href="#66">66</a>  <em>     * returns the name of the database.</em>
<a name="67" href="#67">67</a>  <em>     *</em>
<a name="68" href="#68">68</a>  <em>     * @return the name of the database. May be null.</em>
<a name="69" href="#69">69</a>  <em>     */</em>
<a name="70" href="#70">70</a>      <strong>public</strong> String getName()
<a name="71" href="#71">71</a>      {
<a name="72" href="#72">72</a>          <strong>return</strong> name;
<a name="73" href="#73">73</a>      }
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em>/**<em>*</em></em>
<a name="76" href="#76">76</a>  <em>     * Returns the adapther to this database.</em>
<a name="77" href="#77">77</a>  <em>     *</em>
<a name="78" href="#78">78</a>  <em>     * @return the adapter to this database, or null if no adapter is set.</em>
<a name="79" href="#79">79</a>  <em>     */</em>
<a name="80" href="#80">80</a>      <strong>public</strong> <a href="../../../org/apache/torque/adapter/DB.html">DB</a> getAdapter()
<a name="81" href="#81">81</a>      {
<a name="82" href="#82">82</a>          <strong>return</strong> adapter;
<a name="83" href="#83">83</a>      }
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em>/**<em>*</em></em>
<a name="86" href="#86">86</a>  <em>     * Sets the adapter for this database.</em>
<a name="87" href="#87">87</a>  <em>     *</em>
<a name="88" href="#88">88</a>  <em>     * @param anAdapter The adapter for this database, or null to remove the</em>
<a name="89" href="#89">89</a>  <em>     *        current adapter from this database.</em>
<a name="90" href="#90">90</a>  <em>     */</em>
<a name="91" href="#91">91</a>      <strong>public</strong> <strong>void</strong> setAdapter(<a href="../../../org/apache/torque/adapter/DB.html">DB</a> anAdapter)
<a name="92" href="#92">92</a>      {
<a name="93" href="#93">93</a>          <strong>this</strong>.adapter = anAdapter;
<a name="94" href="#94">94</a>      }
<a name="95" href="#95">95</a>  
<a name="96" href="#96">96</a>      <em>/**<em>*</em></em>
<a name="97" href="#97">97</a>  <em>     * Returns the database map for this database.</em>
<a name="98" href="#98">98</a>  <em>     * If the database map does not exist yet, it is created by this method.</em>
<a name="99" href="#99">99</a>  <em>     */</em>
<a name="100" href="#100">100</a>     <strong>public</strong> <strong>synchronized</strong> <a href="../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a> getDatabaseMap()
<a name="101" href="#101">101</a>     {
<a name="102" href="#102">102</a>         <strong>if</strong> (databaseMap == <strong>null</strong>)
<a name="103" href="#103">103</a>         {
<a name="104" href="#104">104</a>             databaseMap = <strong>new</strong> <a href="../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a>(name);
<a name="105" href="#105">105</a>         }
<a name="106" href="#106">106</a>         <strong>return</strong> databaseMap;
<a name="107" href="#107">107</a>     }
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>     <em>/**<em>*</em></em>
<a name="110" href="#110">110</a> <em>     * Returns the DataSourceFactory for this database.</em>
<a name="111" href="#111">111</a> <em>     * The DataSourceFactory is responsible to create connections</em>
<a name="112" href="#112">112</a> <em>     * to this database.</em>
<a name="113" href="#113">113</a> <em>     *</em>
<a name="114" href="#114">114</a> <em>     * @return the DataSourceFactory for this database, or null if no</em>
<a name="115" href="#115">115</a> <em>     *         DataSourceFactory exists for this database.</em>
<a name="116" href="#116">116</a> <em>     */</em>
<a name="117" href="#117">117</a>     <strong>public</strong> <a href="../../../org/apache/torque/dsfactory/DataSourceFactory.html">DataSourceFactory</a> getDataSourceFactory()
<a name="118" href="#118">118</a>     {
<a name="119" href="#119">119</a>         <strong>return</strong> dataSourceFactory;
<a name="120" href="#120">120</a>     }
<a name="121" href="#121">121</a> 
<a name="122" href="#122">122</a>     <em>/**<em>*</em></em>
<a name="123" href="#123">123</a> <em>     * Sets the DataSourceFactory for this database.</em>
<a name="124" href="#124">124</a> <em>     * The DataSourceFactory is responsible to create connections</em>
<a name="125" href="#125">125</a> <em>     * to this database.</em>
<a name="126" href="#126">126</a> <em>     *</em>
<a name="127" href="#127">127</a> <em>     * @param aDataSourceFactory The new DataSorceFactory for this database,</em>
<a name="128" href="#128">128</a> <em>     *        or null to remove the current DataSourceFactory.</em>
<a name="129" href="#129">129</a> <em>     */</em>
<a name="130" href="#130">130</a>     <strong>public</strong> <strong>void</strong> setDataSourceFactory(<a href="../../../org/apache/torque/dsfactory/DataSourceFactory.html">DataSourceFactory</a> aDataSourceFactory)
<a name="131" href="#131">131</a>     {
<a name="132" href="#132">132</a>         <strong>this</strong>.dataSourceFactory = aDataSourceFactory;
<a name="133" href="#133">133</a>     }
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>     <em>/**<em>*</em></em>
<a name="136" href="#136">136</a> <em>     * Get the IDBroker for this database.</em>
<a name="137" href="#137">137</a> <em>     *</em>
<a name="138" href="#138">138</a> <em>     * @return The IDBroker for this database, or null if no IdBroker has</em>
<a name="139" href="#139">139</a> <em>     *         been started for this database.</em>
<a name="140" href="#140">140</a> <em>     */</em>
<a name="141" href="#141">141</a>     <strong>public</strong> <a href="../../../org/apache/torque/oid/IDBroker.html">IDBroker</a> getIDBroker()
<a name="142" href="#142">142</a>     {
<a name="143" href="#143">143</a>         <strong>if</strong> (databaseMap == <strong>null</strong>)
<a name="144" href="#144">144</a>         {
<a name="145" href="#145">145</a>             <strong>return</strong> <strong>null</strong>;
<a name="146" href="#146">146</a>         }
<a name="147" href="#147">147</a>         <strong>return</strong> databaseMap.getIDBroker();
<a name="148" href="#148">148</a>     }
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>     <em>/**<em>*</em></em>
<a name="151" href="#151">151</a> <em>     * Creates the IDBroker for this DatabaseMap and starts it for the</em>
<a name="152" href="#152">152</a> <em>     * given database.</em>
<a name="153" href="#153">153</a> <em>     * The information about the IdTable is stored in the databaseMap.</em>
<a name="154" href="#154">154</a> <em>     * If an IDBroker already exists for the DatabaseMap, the method</em>
<a name="155" href="#155">155</a> <em>     * does nothing.</em>
<a name="156" href="#156">156</a> <em>     *</em>
<a name="157" href="#157">157</a> <em>     * @return true if a new IDBroker was created, false otherwise.</em>
<a name="158" href="#158">158</a> <em>     */</em>
<a name="159" href="#159">159</a>     <strong>public</strong> <strong>synchronized</strong> <strong>boolean</strong> startIDBroker()
<a name="160" href="#160">160</a>     {
<a name="161" href="#161">161</a>         <a href="../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a> dbMap = getDatabaseMap();
<a name="162" href="#162">162</a>         <strong>if</strong> (dbMap.getIDBroker() != <strong>null</strong>)
<a name="163" href="#163">163</a>         {
<a name="164" href="#164">164</a>             <strong>return</strong> false;
<a name="165" href="#165">165</a>         }
<a name="166" href="#166">166</a>         <strong>return</strong> dbMap.startIdBroker();
<a name="167" href="#167">167</a>     }
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em>/**<em>*</em></em>
<a name="170" href="#170">170</a> <em>     * Returns the IdGenerator of the given type for this Database.</em>
<a name="171" href="#171">171</a> <em>     * @param type The type (i.e.name) of the IdGenerator</em>
<a name="172" href="#172">172</a> <em>     * @return The IdGenerator of the requested type, or null if no IdGenerator</em>
<a name="173" href="#173">173</a> <em>     *         exists for the requested type.</em>
<a name="174" href="#174">174</a> <em>     */</em>
<a name="175" href="#175">175</a>     <strong>public</strong> <a href="../../../org/apache/torque/oid/IdGenerator.html">IdGenerator</a> getIdGenerator(String type)
<a name="176" href="#176">176</a>     {
<a name="177" href="#177">177</a>         <strong>if</strong> (databaseMap == <strong>null</strong>)
<a name="178" href="#178">178</a>         {
<a name="179" href="#179">179</a>             <strong>return</strong> <strong>null</strong>;
<a name="180" href="#180">180</a>         }
<a name="181" href="#181">181</a>         <strong>return</strong> databaseMap.getIdGenerator(type);
<a name="182" href="#182">182</a>     }
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>     <em>/**<em>*</em></em>
<a name="185" href="#185">185</a> <em>     * Adds an IdGenerator to the database.</em>
<a name="186" href="#186">186</a> <em>     * @param type The type of the IdGenerator</em>
<a name="187" href="#187">187</a> <em>     * @param idGen The new IdGenerator for the type, or null</em>
<a name="188" href="#188">188</a> <em>     *        to remove the IdGenerator of the given type.</em>
<a name="189" href="#189">189</a> <em>     */</em>
<a name="190" href="#190">190</a>     <strong>public</strong> <strong>void</strong> addIdGenerator(String type, <a href="../../../org/apache/torque/oid/IdGenerator.html">IdGenerator</a> idGen)
<a name="191" href="#191">191</a>     {
<a name="192" href="#192">192</a>         getDatabaseMap().addIdGenerator(type, idGen);
<a name="193" href="#193">193</a>     }
<a name="194" href="#194">194</a> 
<a name="195" href="#195">195</a>     <em>/**<em>*</em></em>
<a name="196" href="#196">196</a> <em>     * Returns the database schema for this Database.</em>
<a name="197" href="#197">197</a> <em>     * @return the database schema for this database, or null if no schema</em>
<a name="198" href="#198">198</a> <em>     *         has been set.</em>
<a name="199" href="#199">199</a> <em>     */</em>
<a name="200" href="#200">200</a>     <strong>public</strong> String getSchema()
<a name="201" href="#201">201</a>     {
<a name="202" href="#202">202</a>         <a href="../../../org/apache/torque/dsfactory/DataSourceFactory.html">DataSourceFactory</a> dsf = getDataSourceFactory();
<a name="203" href="#203">203</a>         <strong>if</strong> (dsf == <strong>null</strong>)
<a name="204" href="#204">204</a>         {
<a name="205" href="#205">205</a>             <strong>return</strong> <strong>null</strong>;
<a name="206" href="#206">206</a>         }
<a name="207" href="#207">207</a>         <strong>return</strong> dsf.getSchema();
<a name="208" href="#208">208</a>     }
<a name="209" href="#209">209</a> 
<a name="210" href="#210">210</a>     <em>/**<em>*</em></em>
<a name="211" href="#211">211</a> <em>     * Sets the schema for this database.</em>
<a name="212" href="#212">212</a> <em>     * @param schema the name of the database schema to set, or null to remove</em>
<a name="213" href="#213">213</a> <em>     *        the current schema.</em>
<a name="214" href="#214">214</a> <em>     * @throws NullPointerException if no DatasourceFactory exists for this</em>
<a name="215" href="#215">215</a> <em>     *         database.</em>
<a name="216" href="#216">216</a> <em>     */</em>
<a name="217" href="#217">217</a>     <strong>public</strong> <strong>void</strong> setSchema(String schema)
<a name="218" href="#218">218</a>     {
<a name="219" href="#219">219</a>         getDataSourceFactory().setSchema(schema);
<a name="220" href="#220">220</a>     }
<a name="221" href="#221">221</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

